com.inscoper.api.FunctionDescription¶

FunctionDescription class provides function information coming from drivers. More...

Public Functions¶

	Name
synchronized void	delete()
	FunctionDescription() Default constructor.
EFunctionType	getType() Get the type of the function.
void	setType(EFunctionType type) Set the type of the function.
String	getName() Get the name of the function.
void	setName(String name) Set the name of the function.
void	addInputParam(short pos, int tag) Add an input parameter to the function.
UShortUCharMap	getInputParams() Get input parameters.
void	addOutputParam(short pos, int tag) Add an output parameter to the function.
UShortUCharMap	getOutputParams() Get output parameters.
void	addConnection(int tag) Add a connection to the function.
UShortVector	getConnections() Get the connection list.

Protected Functions¶

	Name
	FunctionDescription(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(FunctionDescription obj)

Detailed Description¶

public class com.inscoper.api.FunctionDescription;

FunctionDescription class provides function information coming from drivers.

This class describes a single function of a sub-device, including its type, name, associated input/output parameters, and connections.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

function FunctionDescription¶

public FunctionDescription()

Default constructor.

Initializes a new instance of the FunctionDescription class.

function getType¶

public EFunctionType getType()

Get the type of the function.

Return: The type of the function

Retrieves the functional category of this function.

function setType¶

public void setType(
    EFunctionType type
)

Set the type of the function.

Parameters:

type : The type of the function

Sets the functional category of this function.

function getName¶

public String getName()

Get the name of the function.

Return: The name of the function

Retrieves the display name of the function.

function setName¶

public void setName(
    String name
)

Set the name of the function.

Parameters:

name : The name of the function

Sets the display name of the function.

function addInputParam¶

public void addInputParam(
    short pos,
    int tag
)

Add an input parameter to the function.

Parameters:

pos : The position index of the parameter
tag : The unique tag of the parameter

Sets an input parameter to this function at a specific position.

function getInputParams¶

public UShortUCharMap getInputParams()

Get input parameters.

Return: A map pairing parameter tags with position indices

Retrieves the map of input parameters added to this function.

function addOutputParam¶

public void addOutputParam(
    short pos,
    int tag
)

Add an output parameter to the function.

Parameters:

pos : The position index of the parameter
tag : The unique tag of the parameter

Sets an output parameter to this function at a specific position.

function getOutputParams¶

public UShortUCharMap getOutputParams()

Get output parameters.

Return: A map pairing parameter tags with position indices

Retrieves the map of output parameters added to this function.

function addConnection¶

public void addConnection(
    int tag
)

Add a connection to the function.

Parameters:

tag : The connection's tag

Sets a connection tag to this function.

function getConnections¶

public UShortVector getConnections()

Get the connection list.

Return: The connection list

Retrieves the list of connection tags added to this function.

Protected Functions Documentation¶

function FunctionDescription¶

protected FunctionDescription(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

function finalize¶

protected void finalize()

function getCPtr¶

protected static long getCPtr(
    FunctionDescription obj
)

Updated on 2026-04-02 at 10:55:37 +0200